home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / msgfrm11.zip / MSGFORM.DOC < prev    next >
Text File  |  1990-07-04  |  8KB  |  265 lines
  1.  
  2.                                MSGFORM Version 1.10
  3.  
  4.  
  5.    MSGFORM 1.10 - An RBBS Message Base Utility                  (07/04/90)
  6.  
  7.    Written:     Mike Zakharoff
  8.    Origin :     INTERSTATE BBS NETWORK,  Seattle WA
  9.    FidoNet:     (1:343/36) (206) 631-3231 PCPable (WASEA 1200/2400)
  10.    ----------------------------------------------------------------------
  11.  
  12.                                    PURPOSE
  13.  
  14.    MSGFORM is designed to import ASCII text files into RBBS message bases. 
  15.  
  16.    This  allows  SYSOPS  to create "standard letters"  for  a  variety  of
  17.    situations, a few as follows:
  18.  
  19.       1) WELCOME message after a special registration door.
  20.       2) THANKYOU note for a subscription (my favorite).
  21.       3) A special "broadcast message", addressed to special users
  22.       4) Whatever else!
  23.  
  24.    MSGFORM  is  pretty  flexible,  as  it  can  get  the  TO:  (recipient)
  25.    information from:
  26.  
  27.       1) command line, such as /TO:MIKE ZAKHAROFF
  28.       2) From DORINFOx.DEF                         (/DOR:xx)
  29.       3) From an ASCII LIST of users               (/LST:xx)
  30.  
  31.    NOTE: The /LST:xxx switch will create MULTIPLE messages,  one for  each
  32.          user listed.
  33.  
  34.    Also, you can tell MSGFORM to:
  35.  
  36.       1) Set the security level to a certain level (/SEC:xx)
  37.       2) Make the message private using            (/PRI)
  38.       3) Open message base as SHARED               (/NET)
  39.  
  40.  
  41.    ----------------------------------------------------------------------
  42.  
  43.                                    SYNTAX
  44.  
  45.    MSGFORM  1.10 (07/04/90)  Mike Zakharoff INTERSTATE BBS NETWORK, Seattle WA
  46.                                             FidoNet (1:343/36)  (206)631-3231
  47.  
  48.    MSGFORM  /LTR:xx /MSG:xx [OPTIONS] /TO:Fname Lname
  49.  
  50.    /LTR:xxx   Ascii form letter to import
  51.    /MSG:xxx   Message base to send /LTR:xxx
  52.    /TO:Fn Ln  Where Fn = First Name and Ln = Last Name of recipient
  53.  
  54.    [OPTIONS]
  55.  
  56.    /DOR:xxx   Where xxx = DORINFOx.DEF File where /TO: is retrieved
  57.    /LST:xxx   Where xxx = FILE containing a LIST of Names for /TO:
  58.    /SEC:xxx   Where xxx = Security Level of imported message
  59.    /PRI       Make message PRIVATE
  60.    /NET       Open Message base as SHARED
  61.  
  62.    NOTE:      If "/TO:xxx xxx"  is used, it ** MUST ** be the LAST command
  63.               line switch!
  64.  
  65.                                       Page: 1
  66.  
  67.  
  68.                                MSGFORM Version 1.10
  69.  
  70.  
  71.    ----------------------------------------------------------------------
  72.  
  73.                               COMMAND EXECUTION
  74.  
  75.    Very simple.  Supply the following information on the command line:
  76.  
  77.       1) The name of the letter or form to import (/LTR:xxx)
  78.       2) The name of the message base to receive  (/MSG:xxx)
  79.       3) Who is to receive the letter             (/TO:Ln Fn)
  80.  
  81.    So the minimum command would be....
  82.  
  83.       MSGFORM /LTR:letter1 /MSG:messages /TO:Jim Smite <rtn>
  84.  
  85.  
  86.                                  IMPORTANT!
  87.                                  ^^^^^^^^^^
  88.  
  89.    The "/TO:xxxx xxxx"  MUST be the LAST item entered on the command  line
  90.    switch.   MSGFORM will assume the name will be everything to the  RIGHT
  91.    of the "/TO:" entry.
  92.  
  93.    Ascii letter file MUST have the following format:
  94.  
  95.       Line 1 - Who the message is FROM
  96.       Line 2 - Subject of the message
  97.       Line 3 + Text of message
  98.  
  99.    In  the  text  of the letter,  the keywords [FIRST] &  [LAST]  will  be
  100.    replaced with the users first and last for dynamic replacement.
  101.  
  102.    NOTE: See supplied "letter1" for an example of the form letter
  103.  
  104.  
  105.                            COMMAND LINE [OPTIONS]
  106.                            ----------------------
  107.  
  108.    /DOR:xxx
  109.    --------
  110.              The  /DOR:xxx  switch allows you to retrieve the  users  name
  111.              from the respective DORINFOx.DEF file,  and THAT will replace
  112.              the  /TO:xxx xxx entry that is used with the minimum  command
  113.              line switch.
  114.  
  115.              Example:
  116.  
  117.              MSGFORM /LTR:letter1 /MSG:messages /DOR:dorinfo1.def <rtn>
  118.  
  119.              Of  course,   you  could  replace  the  "dorinfo1.def"   with
  120.              "dorinfo%1.def"  and RBBS can replace the node number when it
  121.              exits to a registration door or whatever.
  122.  
  123.              NOTE: With this option, "/TO:" is NOT used.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.                                       Page: 2
  132.  
  133.  
  134.                                MSGFORM Version 1.10
  135.  
  136.  
  137.    /LST:xxx
  138.    --------
  139.  
  140.              The  /LST:xxx switch allows you to create MULTIPLE  messages,
  141.              one  for  each user listed in the FILE "xxx".   This  may  be
  142.              useful if  you have a select group of users,  and you want to
  143.              send a  personal message to all of them.
  144.              Simply create a file (called anything) such as:
  145.  
  146.              JOHN USER
  147.              MIKE TOSSER
  148.              TIM SMITH
  149.              ROBERT IDIOT
  150.              etc...
  151.  
  152.              Execute MSGFORM as follows....
  153.  
  154.              MSGFORM /LTR:letter1 /MSG:messages /LST:userlist <rtn>
  155.  
  156.              MSGFORM  will create one single message,  one for  each  user
  157.              listed.
  158.  
  159.              NOTE: With this option, "/TO:" is NOT used.
  160.  
  161.    /SEC:xxx
  162.    --------
  163.  
  164.              The  /SEC:xxx  allows you to set the security  level  of  the
  165.              message, such as:
  166.  
  167.              MSGFORM /LTR:letter1 /MSG:messages /SEC:40 /TO:mike zakharoff
  168.  
  169.              Will set this message to PUBLIC, SECURITY level of 40.
  170.  
  171.    /PRI
  172.    ----
  173.  
  174.              The /PRI switch will set the message to PRIVATE, vice PUBLIC. 
  175.              Such as:
  176.  
  177.              MSGFORM /LTR:letter1 /MSG:messages /SEC:40 /PRI /TO:mike z
  178.  
  179.    /NET
  180.    ----
  181.  
  182.              The  /NET  will  open  the  message  bases  as  SHARED,   for
  183.              NETBIOS-type environments.  Such as:
  184.  
  185.              MSGFORM /LTR:letter1 /MSG:messages /NET /TO:mike zakharoff
  186.  
  187.  
  188.                                  IMPORTANT!
  189.                                  ^^^^^^^^^^
  190.  
  191.    ALWAYS place the /TO:  related switches (/TO:,  /LST:  & /DOR:) last on
  192.    the command line.
  193.  
  194.    Also, you can NOT mix /TO: related switches.
  195.  
  196.  
  197.                                       Page: 3
  198.  
  199.  
  200.                                MSGFORM Version 1.10
  201.  
  202.  
  203.    ----------------------------------------------------------------------
  204.  
  205.                             IMPORTING INFORMATION
  206.                             ---------------------
  207.  
  208.    When  importing  a letter,  any line greater than 72  characters  (RBBS
  209.    standard) will be formatted as a paragraph.  If you  want to get fancy,
  210.    you  can  simply create the file where it will always be LESS  than  72
  211.    characters, and it will be imported exactly the same as the letter.
  212.  
  213.    If [FIRST] and [LAST] are present in the letter,  MSGFORM will  replace
  214.    their  occurrence with the users first and last,  but only if the  name
  215.    has a first and last name.   "SYSOP" will make both [FIRST] & [LAST] be
  216.    equal to "SYSOP".
  217.  
  218.    Also,  users that have TWO spaces between, like "JOHN M SMITH", will be
  219.    imported properly,  and [FIRST] will be equal to "JOHN" and [LAST] will
  220.    be equal to "M SMITH".
  221.  
  222.    NOTE: MSGFORM does NOT bother setting the mailwaiting bits.
  223.  
  224.    Applications are only limited by your own creativity!
  225.  
  226.                                   REVISIONS
  227.                                   ---------
  228.  
  229.    06-30-90 - Version 1.0 - Original release
  230.  
  231.    07-04-90 - Version 1.1 - Bug Fix of 1.0
  232.  
  233.         1) Fixed  command  line bug where sending to "ALL"  didn't  always
  234.            work.
  235.  
  236.         2) [FIRST]  &  [LAST] will now work with users with  single  names 
  237.            like "SYSOP"  or "ALL".  Both [FIRST] & [LAST] will be equal to
  238.            the single name.
  239.  
  240.         3) Fixed  importing where users with TWO  spaces  ("JOHN M SMITH")
  241.            would be imported as "JOHN M".   For these cases,  [FIRST] will
  242.            now be equal to "JOHN" and [LAST] will be equal to "M SMITH".
  243.  
  244.  
  245.    Other RBBS programs I have written:
  246.  
  247.    MSGTOSS  - Fast Fidonet message importer for RBBS (fast!)
  248.    MSGRENUM - Renumber RBBS message bases w/o CONFIG
  249.    FIXMSG   - Repair RBBS message bases w/o CONFIG
  250.    MAILWAIT - Maintain RBBS "mailwaiting bits"
  251.    MSGECHO  - Obsolete due to MSGTOSS
  252.  
  253.    Thanks,     Mike Zakharoff
  254.                INTERSTATE BBS NETWORK
  255.                (206)631-3231
  256.                FidoNet 1:343/36
  257.                RBBS-NET 8:918/1
  258.  
  259.  
  260.  
  261.  
  262.  
  263.                                       Page: 4
  264.  
  265.